docs: document the commit message convention (closes #94) - #218
Open
dchaudhari7177 wants to merge 1 commit into
Open
docs: document the commit message convention (closes #94)#218dchaudhari7177 wants to merge 1 commit into
dchaudhari7177 wants to merge 1 commit into
Conversation
…ce-kit#94) CONTRIBUTING did not specify a commit style. Documents the Conventional Commits format the repo already follows in practice, with the workspace names as the scope vocabulary and worked examples. The convention is described from the existing history rather than invented: the one non-merge commit on main is "fix(sep10-auth): restore revocation/logger docs...", and merged branches consistently use feat/, fix/, docs/, ci/, chore/ and test/ prefixes. commitlint is noted as not currently wired, with the natural setup if it is added later, so the section does not imply a check that does not exist. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #94.
CONTRIBUTING.mddidn't specify a commit style. Adds a Commit messages section documenting Conventional Commits, with the type list, the workspace names as the scope vocabulary, subject-line rules, and four worked examples.Described, not invented
I took the convention from the repo's own history rather than picking one:
mainisfix(sep10-auth): restore revocation/logger docs and exports dropped by PR #195's mergefeat/,fix/,docs/,ci/,chore/,test/prefixesSo this documents what contributors are already doing, which should make it uncontroversial to enforce in review.
On commitlint
The issue said "consider wiring
commitlintin CI". I've documented it as not currently wired, with a note on the natural setup (@commitlint/config-conventional+ acommit-msghook) if you want it later.I deliberately didn't add it in this PR: it's a new dev dependency plus a CI step that would start failing PRs on message format, which feels like a maintainer call rather than something to slip into a docs change. Say the word and I'll open a follow-up that wires it.
Docs-only change.
🤖 Generated with Claude Code